Platform Explorer / Nuxeo Platform 2021.25

Extension point pages

Documentation

The pages extension point allows to define a set of resources and resource bundles for a given "page", as well as additional information about available flavors, for instance.

Example:

    <page charset="utf-8" name="galaxy/default">
        <defaultFlavor>default</defaultFlavor>
        <flavors>
            <flavor>default</flavor>
            <flavor>rainbow</flavor>
        </flavors>
        <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_header_footer</bundle>
            <bundle>nuxeo_dm</bundle>
            <resource>my_resource.css</resource>
        </resources>
    </page>

The charset and favorites are used inside the page head.

Flavors define available flavors on this page, resource bundles are also references (see corresponding extension points on this same component).

This extension point accepts merge. When contributing new elements to flavors or resources, the attribute append="true" should be added, otherwise existing configurations will be overridden.

Attribute "charset" is available only since 7.4 (it was previously defined by the Theme extension point layout configuration).

Deprecation note: since 7.4, the 'themePage' element is deprecated: just change it to use the 'page' element instead.

Contribution Descriptors

  • Class: org.nuxeo.theme.styling.service.descriptors.ThemePage
  • Class: org.nuxeo.theme.styling.service.descriptors.PageDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-admin-center-jsf-2021.25.8.jar /OSGI-INF/theme-contrib.xml
    <extension point="pages" target="org.nuxeo.theme.styling.service">
    
        <page charset="utf-8" name="admin/default">
          <defaultFlavor>default</defaultFlavor>
          <flavors>
            <flavor>default</flavor>
            <flavor>rainbow</flavor>
          </flavors>
          <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_sassCss</bundle>
            <resource>nuxeo_admincenter_specific.scss</resource>
          </resources>
        </page>
    
      </extension>
  • nuxeo-platform-webapp-core-2021.25.8.jar /OSGI-INF/theme-contrib.xml
    <extension point="pages" target="org.nuxeo.theme.styling.service">
    
        <page charset="utf-8" name="galaxy/print">
          <defaultFlavor>default</defaultFlavor>
          <flavors>
            <flavor>default</flavor>
            <flavor>rainbow</flavor>
          </flavors>
          <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_sassCss</bundle>
            <resource>print_generic.scss</resource>
          </resources>
        </page>
    
        <page charset="utf-8" name="galaxy/popup">
          <defaultFlavor>default</defaultFlavor>
          <flavors>
            <flavor>default</flavor>
            <flavor>rainbow</flavor>
          </flavors>
          <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_sassCss</bundle>
            <bundle>nuxeo_dm</bundle>
          </resources>
        </page>
    
        <page charset="utf-8" name="galaxy/default">
          <defaultFlavor>default</defaultFlavor>
          <flavors>
            <flavor>default</flavor>
            <flavor>rainbow</flavor>
          </flavors>
          <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_sassCss</bundle>
            <bundle>nuxeo_dm</bundle>
          </resources>
        </page>
    
      </extension>
  • nuxeo-diff-jsf-2021.25.8.jar /OSGI-INF/diff-theme-contrib.xml
    <extension point="pages" target="org.nuxeo.theme.styling.service">
    
        <page name="galaxy/default">
          <resources append="true">
            <resource>diff.css</resource>
          </resources>
        </page>
    
      </extension>
  • nuxeo-search-ui-2021.25.8.jar /OSGI-INF/search-theme-contrib.xml
    <extension point="pages" target="org.nuxeo.theme.styling.service">
    
        <themePage name="search/default">
          <defaultFlavor>default</defaultFlavor>
          <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_sassCss</bundle>
            <resource>nuxeo_search_specific.scss</resource>
          </resources>
        </themePage>
    
      </extension>
  • nuxeo-user-center-2021.25.8.jar /OSGI-INF/theme-contrib.xml
    <extension point="pages" target="org.nuxeo.theme.styling.service">
    
        <themePage charset="utf-8" name="userCenter/default">
          <defaultFlavor>default</defaultFlavor>
          <flavors>
            <flavor>default</flavor>
            <flavor>rainbow</flavor>
          </flavors>
          <resources>
            <bundle>nuxeo_includes</bundle>
            <bundle>nuxeo_base</bundle>
            <bundle>nuxeo_sassCss</bundle>
            <resource>nuxeo_usercenter_specific.scss</resource>
          </resources>
        </themePage>
    
      </extension>
  • nuxeo-user-profile-jsf-2021.25.8.jar /OSGI-INF/theme-contrib.xml
    <extension point="pages" target="org.nuxeo.theme.styling.service">
    
        <themePage name="userCenter/default">
          <resources append="true">
            <resource>user_profile.scss</resource>
          </resources>
        </themePage>
        <themePage name="admin/default">
          <resources append="true">
            <resource>user_profile.scss</resource>
          </resources>
        </themePage>
    
      </extension>